Skip to content

AM62A edgeai docs support #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jeevantelukula merged 3 commits into from
Jun 3, 2025
Merged

AM62A edgeai docs support #286

jeevantelukula merged 3 commits into from
Jun 3, 2025

Conversation

@jeevantelukula
Copy link
Collaborator

@jeevantelukula jeevantelukula commented May 9, 2025

@github-actions
Copy link

github-actions bot commented May 9, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:1: (SEVERE/4) Problems with "include" directive path:
source/devices/AM62AX/edgeai/getting_started.rst:7: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) `docker save --output <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) `docker load --input <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) `docker rmi <image_name/ID>'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) `docker rm <container_ID>'
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_ecosystem.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/measure_perf.rst:67: (ERROR/3) (bash) syntax error near unexpected token `('
source/edgeai/measure_perf.rst:67: (ERROR/3) (bash) `CPU: mpu1_0: TOTAL LOAD = 43.81 % ( HWI =  0.74 %, SWI =  0.24 % )'
source/edgeai/measure_perf.rst:97: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/measure_perf.rst:97: (ERROR/3) (bash) `|element                      latency     out-latancy     out-fps    frames    |'
source/edgeai/measure_perf.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/sdk_components.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/setup_psdk_rtos.sh'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) `<PSDK-RTOS path>#sudo ./psdk_rtos/scripts/mk-linux-card.sh /dev/sda'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/install_to_sd_card.sh'
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/sdk_overview.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/inference_models.rst:183: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/inference_models.rst:183: (ERROR/3) (bash) `|'
source/edgeai/inference_models.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/configuration_file.rst:1: (SEVERE/4) Problems with "include" directive path:
source/edgeai/sample_apps.rst:1: (SEVERE/4) Problems with "include" directive path:

@github-actions
Copy link

github-actions bot commented May 9, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:117: (ERROR/3) (bash) `docker save --output <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:128: (ERROR/3) (bash) `docker load --input <pre_built_docker_image.tar>'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:140: (ERROR/3) (bash) `docker rmi <image_name/ID>'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/docker_environment.rst:156: (ERROR/3) (bash) `docker rm <container_ID>'
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/measure_perf.rst:65: (ERROR/3) (bash) syntax error near unexpected token `('
source/edgeai/measure_perf.rst:65: (ERROR/3) (bash) `CPU: mpu1_0: TOTAL LOAD = 43.81 % ( HWI =  0.74 %, SWI =  0.24 % )'
source/edgeai/measure_perf.rst:95: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/measure_perf.rst:95: (ERROR/3) (bash) `|element                      latency     out-latancy     out-fps    frames    |'
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:50: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/setup_psdk_rtos.sh'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:91: (ERROR/3) (bash) `<PSDK-RTOS path>#sudo ./psdk_rtos/scripts/mk-linux-card.sh /dev/sda'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) syntax error near unexpected token `newline'
source/edgeai/development_flow.rst:103: (ERROR/3) (bash) `<PSDK-RTOS path>#./psdk_rtos/scripts/install_to_sd_card.sh'
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/inference_models.rst:181: (ERROR/3) (bash) syntax error near unexpected token `|'
source/edgeai/inference_models.rst:181: (ERROR/3) (bash) `|'

@jeevantelukula
Copy link
Collaborator Author

jeevantelukula commented May 9, 2025

StaticRocket
StaticRocket previously requested changes May 9, 2025
View reviewed changes
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got some concerns about the current structure, but otherwise I think this will be useful.

@cshilwant
Copy link
Member

cshilwant commented May 10, 2025

@jeevantelukula hope you are planning to address the errors by rstcheck as well - #286 (comment)

@cshilwant
Copy link
Member

cshilwant commented May 11, 2025

+ @sadik-smd @jsuhaas22 for reviews

@github-actions
Copy link

github-actions bot commented May 12, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

StaticRocket
StaticRocket reviewed May 14, 2025
View reviewed changes
@github-actions
Copy link

github-actions bot commented May 21, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

cshilwant
cshilwant previously requested changes May 21, 2025
View reviewed changes
@github-actions
Copy link

github-actions bot commented May 23, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/docker_environment.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "5" (ordinal 5)
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

@github-actions
Copy link

github-actions bot commented May 23, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

@cshilwant cshilwant dismissed stale reviews from StaticRocket and themself May 23, 2025 13:59

author has updated the PR

@cshilwant cshilwant self-requested a review May 23, 2025 14:01
@cshilwant
Copy link
Member

cshilwant commented May 23, 2025

@StaticRocket @sadik-smd to re-review

cshilwant
cshilwant previously approved these changes May 23, 2025
View reviewed changes
Copy link
Member

@cshilwant cshilwant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see more cleanups but we can do that as a follow up PRs.
For now, this LGTM to enable bleeding EdgeAI SDK docs for AM62A on github.io

glneo
glneo reviewed May 23, 2025
View reviewed changes
@jeevantelukula
feat: Add support for AM62A edgeai docs
d2c17d1 
Till now the edgeai sdk docs for AM62A are maintained in a
bitbucket repository. This commit adds support for building
the edgeai docs for AM62A.

The edgeai docs can be built similar to processor-sdk-docs but
with OS as edgeai.

Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
@jeevantelukula
feat: Add building AM62A edgeai docs in github workflow
546fcd5 
Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
@jeevantelukula
feat: Update component owners for AM62AX edgeai docs
056ad9b 
Add default owners for AM62A edgeai in component owners list
for PR reviews on AM62A edgeai docs.

Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>
@github-actions
Copy link

github-actions bot commented Jun 2, 2025

New warnings found with rstcheck:

source/devices/AM62AX/edgeai/getting_started.rst:5: (INFO/1) Duplicate explicit target name: "user guide".
source/edgeai/edgeai_dataflows.rst:242: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:285: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:329: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:372: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:423: (INFO/1) Duplicate implicit target name: "multi input multi inference".

@jeevantelukula jeevantelukula requested a review from cshilwant June 2, 2025 08:46
@StaticRocket StaticRocket requested a review from glneo June 2, 2025 19:22
StaticRocket
StaticRocket approved these changes Jun 2, 2025
View reviewed changes
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should work for now

@jeevantelukula jeevantelukula merged commit 13795bd into TexasInstruments:master Jun 3, 2025
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StaticRocket StaticRocket StaticRocket approved these changes

@jsuhaas22 jsuhaas22 jsuhaas22 approved these changes

@cshilwant cshilwant cshilwant approved these changes

@praneethbajjuri praneethbajjuri Awaiting requested review from praneethbajjuri praneethbajjuri is a code owner

@uditkumarti uditkumarti Awaiting requested review from uditkumarti uditkumarti is a code owner

@aniket-l aniket-l Awaiting requested review from aniket-l

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi is a code owner

@sadik-smd sadik-smd Awaiting requested review from sadik-smd

@glneo glneo Awaiting requested review from glneo

Assignees

@StaticRocket StaticRocket

@jsuhaas22 jsuhaas22

@cshilwant cshilwant

@jeevantelukula jeevantelukula

@sadik-smd sadik-smd

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jeevantelukula @cshilwant @glneo @StaticRocket @jsuhaas22 @sadik-smd